'\"macro stdmacro
.\"
.\" Copyright (c) 2018 Red Hat.
.\"
.\" This program is free software; you can redistribute it and/or modify it
.\" under the terms of the GNU General Public License as published by the
.\" Free Software Foundation; either version 2 of the License, or (at your
.\" option) any later version.
.\"
.\" This program is distributed in the hope that it will be useful, but
.\" WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
.\" or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
.\" for more details.
.\"
.\"
.TH PMDASMART 1 "PCP" "Performance Co-Pilot"
.SH NAME
\f3pmdasmart\f1 \- S.M.A.R.T Data PMDA
.SH DESCRIPTION
.B pmdasmart
is a Performance Metrics Domain Agent (PMDA) which exports
metric values for Device Mapper on the local system.
.PP
This PMDA collects its data through the
.BR smartctl (8)
utility and requires that the program is installed in order to function.
.PP
Further details on smartctl and smartmontools can be found at
.BR https://smartmontools.org .
.SH INSTALLATION
Install the SMART PMDA by using the Install script as root:
.sp 1
.RS +4
.ft B
.nf
# cd $PCP_PMDAS_DIR/smart
# ./Install
.fi
.ft P
.RE
.sp 1
.PP
To uninstall, do the following as root:
.sp 1
.RS +4
.ft B
.nf
# cd $PCP_PMDAS_DIR/smart
# ./Remove
.fi
.ft P
.RE
.sp 1
.B pmdasmart
is launched by
.BR pmcd (1)
and should never be executed directly.
The Install and Remove scripts notify
.B pmcd
when the agent is installed or removed.
.SH FILES
.IP "\fB$PCP_PMDAS_DIR/smart/help\fR" 4
default help text file for the smart metrics
.IP "\fB$PCP_PMDAS_DIR/smart/Install\fR" 4
installation script for the \fBpmdasmart\fR agent
.IP "\fB$PCP_PMDAS_DIR/smart/Remove\fR" 4
undo installation script for the \fBpmdasmart\fR agent
.IP "\fB$PCP_LOG_DIR/pmcd/smart.log\fR" 4
default log file for error messages from \fBpmdasmart\fR
.SH PCP ENVIRONMENT
Environment variables with the prefix \fBPCP_\fR are used to parameterize
the file and directory names used by \fBPCP\fR. On each installation, the
file \fB/etc/pcp.conf\fR contains the local values for these variables.
The \fB$PCP_CONF\fR variable may be used to specify an alternative
configuration file, as described in \fIpcp.conf\fR(5).
.SH SEE ALSO
.BR PCPIntro (1),
.BR pmcd (1)
and
.BR smartctl (8).
